/*
 *  Copyright (c) 1998, Regents of the University of California
 *  All rights reserved.
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 * 
 *      * Redistributions of source code must retain the above copyright
 *        notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *        notice, this list of conditions and the following disclaimer in the
 *        documentation and/or other materials provided with the distribution.
 *      * Neither the name of the University of California, Berkeley nor the
 *        names of its contributors may be used to endorse or promote products
 *        derived from this software without specific prior written permission.
 * 
 *  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
 *  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 *  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.demis.troll;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.demis.troll.helper.NameHelper;

/**
 * @version 1.0
 * @author <a href="mailto:demis27@demis27.net">Stéphane kermabon</a>
 */
public class ClassDescriptor {

    private final Log logger = LogFactory.getLog(ClassDescriptor.class);

    private String className = null;
    
    private PackageDescriptor packageDescriptor = null;

    private Set<PackageDescriptor> importPackages = new HashSet<PackageDescriptor>();

    private IdentDescriptor ident = null;

    private List<PropertyDescriptor> properties = new ArrayList<PropertyDescriptor>();
    
    private List<RelationDescriptor> leftRelations = new ArrayList<RelationDescriptor>();

    private List<RelationDescriptor> rightRelations = new ArrayList<RelationDescriptor>();

    public ClassDescriptor() {
        // no op
    }

    public String getClassName() {
        return className;
    }

    public void setClassName(String className) {
        this.className = className;
    }

    public PackageDescriptor getPackageDescriptor() {
        return packageDescriptor;
    }

    public void setPackageDescriptor(PackageDescriptor packageDescriptor) {
        this.packageDescriptor = packageDescriptor;
        packageDescriptor.addClass(this);
    }

    public List<PropertyDescriptor> getProperties() {
        return properties;
    }

    public void addProperty(PropertyDescriptor property) {
        property.setClassDescriptor(this);
        properties.add(property);
    }
    
    public void addProperties(List<PropertyDescriptor> propertiesToAdd) {
        for (PropertyDescriptor property: propertiesToAdd) {
            this.properties.add(property);
        }
    }

    public IdentDescriptor getIdent() {
        return ident;
    }
    
    public void setIdent(IdentDescriptor ident) {
        this.ident = ident;
    }

    public List<RelationDescriptor> getLeftRelations() {
        return leftRelations;
    }

    public void setLeftRelations(List<RelationDescriptor> leftRelations) {
        this.leftRelations = leftRelations;
    }

    public List<RelationDescriptor> getRightRelations() {
        return rightRelations;
    }

    public void setRightRelations(List<RelationDescriptor> rightRelations) {
        this.rightRelations = rightRelations;
    }

    public void addLeftRelation(RelationDescriptor relation) {
        leftRelations.add(relation);
    }

    public void addRightRelation(RelationDescriptor relation) {
        rightRelations.add(relation);
    }

    public void addImportPackage(PackageDescriptor descriptor) {
        importPackages.add(descriptor);
    }

    public Set<PackageDescriptor> getImportPackages() {
        return importPackages;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final ClassDescriptor other = (ClassDescriptor) obj;
        if ((this.className == null) ? (other.className != null) : !this.className.equals(other.className)) {
            return false;
        }
        if (this.packageDescriptor != other.packageDescriptor && (this.packageDescriptor == null || !this.packageDescriptor.equals(other.packageDescriptor))) {
            return false;
        }
        return true;
    }

    @Override
    public int hashCode() {
        int hash = 3;
        hash = 41 * hash + (this.className != null ? this.className.hashCode() : 0);
        hash = 41 * hash + (this.packageDescriptor != null ? this.packageDescriptor.hashCode() : 0);
        return hash;
    }

    @Override
    public String toString() {
        return packageDescriptor != null ? packageDescriptor + "." + className : className ;
    }

    public String getObjectName() {
        return NameHelper.getInstance().toLowerCaseFirstLetter(className);
    }
}
